﻿//_______________________________________________________________________________________________________________________
// Copy Right (c) 2010, 2011 SapiensIT Consulting GmbH, all rights reserved
//_______________________________________________________________________________________________________________________
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT
// NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//_______________________________________________________________________________________________________________________
// PROJECT:     sapiens.at.SharePoint.QueryBuilder (SharePoint 2010/V4)
//_______________________________________________________________________________________________________________________
// VERSION:     2.0
//_______________________________________________________________________________________________________________________
// DESCRIPTION: 
//_______________________________________________________________________________________________________________________
// LICENSE:     Different licens Types apply to different file types:
//               - Source code files are governed by the MICROSOFT PUBLIC LICENSE (Ms-PL)
//               - Binary files are governed by MSDN CODE GALLERY BINARY LICENSE
//               - Documentation files are governed by CREATIVE COMMONS ATTRIBUTION 3.0 LICENSE
//
//               The licenses can be found at the projects source location.
//               If you do not agree, don't use it!
// 
//_______________________________________________________________________________________________________________________
// Start SharePoint Branding, visit http://www.cliggin.com! Visit us on http://www.sapiens.at! Tell your friends! 
//_______________________________________________________________________________________________________________________
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Sapiens.at.SharePoint.Utils
{
    /// <summary>
    /// Reprecents a CAML expression to query datetime fields.
    /// </summary>
    public class QueryBuilderDateTimeValueOperator:QueryBuilderValueOperator<DateTime>
    {
        /// <summary>
        /// Gets or sets whether the time part is included in the query.
        /// </summary>
        public bool IncludeTimeValue;
        /// <summary>
        /// Instantiates a new operator.
        /// </summary>
        /// <param name="type">The <see cref="QueryBuilderOperator.Type"/> of the expression</param>
        /// <param name="fieldRef">The <see cref="QueryBuilderOperator.FieldRef"/> of the expression</param>
        /// <param name="value">The value to compare</param>
        public QueryBuilderDateTimeValueOperator(string type, string fieldRef, DateTime value)
            : this(type, fieldRef, value, false) {  }

        /// <summary>
        /// Instantiates a new operator.
        /// </summary>
        /// <param name="type">The <see cref="QueryBuilderOperator.Type"/> of the expression</param>
        /// <param name="fieldRef">The <see cref="QueryBuilderOperator.FieldRef"/> of the expression</param>
        /// <param name="value">The value to compare</param>
        /// <param name="includeTimeValue">Indicates whether the time part is included in the query</param>
        public QueryBuilderDateTimeValueOperator(string type, string fieldRef, DateTime value, bool includeTimeValue)
            :base(type, fieldRef, value, false)
        {
            IncludeTimeValue = includeTimeValue;
        }
        /// <summary>
        /// Converts the expression into the CAML representation.
        /// </summary>
        /// <returns>The CAML query for this expression</returns>
        public override string ToString()
        {
            return string.Format("<{0}><FieldRef Name=\"{1}\"/><Value Type=\"{2}\"{3}>{4}</Value></{0}>",
                Type,
                FieldRef,
                GetCamlDataType(),
                IncludeTimeValue ? " IncludeTimeValue=\"TRUE\"" : string.Empty,
                GetCamlValue());
        }
    }
}
